Skip to content

Added markdownlint2 for detecting Markdown formatting issues#3102

Open
mnocon wants to merge 2 commits into5.0from
lint-markdown
Open

Added markdownlint2 for detecting Markdown formatting issues#3102
mnocon wants to merge 2 commits into5.0from
lint-markdown

Conversation

@mnocon
Copy link
Contributor

@mnocon mnocon commented Mar 20, 2026

Target: v5, 4.6

Issues like in #3100 should be detected automatically by tools, we shouldn't stumble on it by mistake.

This PR adds a Markdown linter that can automatically detect issues like these.

Usage in GitLab:

https://docs.gitlab.com/development/documentation/testing/markdownlint/

Rules:

https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#rules

For now, I've only enabled the rules that:

  • don't report any errors
  • would detect the Markdown table issue

For in the future we can consider more of them (but that would require more changes to the content, and I want to keep this PR small on purpose).

Contains a TMP commit to verify that it works

@sonarqubecloud
Copy link

❌ The last analysis has failed.

See analysis details on SonarQube Cloud

Install dependencies:

```bash
yarn install
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

I have no idea what Vale means here - maybe #3099 would help?

@mnocon mnocon marked this pull request as ready for review March 24, 2026 08:25
@mnocon mnocon requested a review from a team March 24, 2026 08:25
@ibexa-workflow-automation-1 ibexa-workflow-automation-1 bot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team March 24, 2026 08:26
| [LogicalAnd](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-LogicalAnd.html) | Composite criterion to group multiple criteria using the AND condition |
| [LogicalOr](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-LogicalOr.html) | Composite criterion to group multiple criteria using the OR condition |
| [ParticipantScope](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-ParticipantScope.html) | Find invitations based on participant's scope, see [`ContentSessionScope`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Collaboration-ContentSessionScope.html) for content-sharing sessions |
| [ParticipantScope](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-ParticipantScope.html)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes are TMP and done on purpose (928c29b) to see if they are detected correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant